Request a list of Campaigns result Schema
api_result Element
Description
starts a results connection.
Namespace (none)
Diagram
result Element num_results Element authentication Element Sequence api_result Element
Overview
api_result
starts a results connection.
Sequence
authentication xs:string
Confirmation that the username and password has been accepted.
num_results xs:int
Defines the number of results in this report.
result 0..∞
You can have multiple results per campaign list report.
Sequence
type xs:string
Defines the type of report.  In this case it will always be "optout
campaign_id xs:string
This is the PRODOCOM system ID for a campaign. 
msg_id xs:string
This is the PRODOCOM system ID for a message within a campaign. A campaign may contain many messages each with many destinations.
status xs:string
Confirms the current status for this campaign.
start_date_gmt xs:string
The start date and time in GMT (Greenwich Mean Time) of the campaign.
finish_date_gmt xs:string
The finish date and time in GMT (Greenwich Mean Time) of the campaign.
charge_code xs:string
An optional field that you can use to break up your jobs on the invoice from PRODOCOM.
reference xs:string
An optional field.  When used with emails, this is the subject line of the email.  Otherwise, can be used for client reporting purposes.
Source
<xs:element name="api_result" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="authentication" />
      <xs:element type="xs:int" name="num_results" />
      <xs:element name="result" maxOccurs="unbounded" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="type" />
            <xs:element type="xs:string" name="campaign_id" />
            <xs:element type="xs:string" name="msg_id" />
            <xs:element type="xs:string" name="status" />
            <xs:element type="xs:string" name="start_date_gmt" />
            <xs:element type="xs:string" name="finish_date_gmt" />
            <xs:element type="xs:string" name="charge_code" />
            <xs:element type="xs:string" name="reference" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
Request a list of Campaigns result Schema

 

 


© 2013 All Rights Reserved.

Send comments on this topic.